<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span><a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>package org.apache.commons.net.ftp.parser;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.regex.MatchResult;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.regex.Matcher;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.regex.Pattern;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.regex.PatternSyntaxException;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.commons.net.ftp.FTPFileEntryParserImpl;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>/**<a name="line.28"></a>
<span class="sourceLineNo">029</span> * This abstract class implements both the older FTPFileListParser and<a name="line.29"></a>
<span class="sourceLineNo">030</span> * newer FTPFileEntryParser interfaces with default functionality.<a name="line.30"></a>
<span class="sourceLineNo">031</span> * All the classes in the parser subpackage inherit from this.<a name="line.31"></a>
<span class="sourceLineNo">032</span> *<a name="line.32"></a>
<span class="sourceLineNo">033</span> * This is the base class for all regular expression based FTPFileEntryParser classes<a name="line.33"></a>
<span class="sourceLineNo">034</span> *<a name="line.34"></a>
<span class="sourceLineNo">035</span> * @author Steve Cohen &lt;scohen@apache.org&gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span> */<a name="line.36"></a>
<span class="sourceLineNo">037</span>public abstract class RegexFTPFileEntryParserImpl extends<a name="line.37"></a>
<span class="sourceLineNo">038</span>        FTPFileEntryParserImpl {<a name="line.38"></a>
<span class="sourceLineNo">039</span>    /**<a name="line.39"></a>
<span class="sourceLineNo">040</span>     * internal pattern the matcher tries to match, representing a file<a name="line.40"></a>
<span class="sourceLineNo">041</span>     * entry<a name="line.41"></a>
<span class="sourceLineNo">042</span>     */<a name="line.42"></a>
<span class="sourceLineNo">043</span>    private Pattern pattern = null;<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span>    /**<a name="line.45"></a>
<span class="sourceLineNo">046</span>     * internal match result used by the parser<a name="line.46"></a>
<span class="sourceLineNo">047</span>     */<a name="line.47"></a>
<span class="sourceLineNo">048</span>    private MatchResult result = null;<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span>    /**<a name="line.50"></a>
<span class="sourceLineNo">051</span>     * Internal PatternMatcher object used by the parser.  It has protected<a name="line.51"></a>
<span class="sourceLineNo">052</span>     * scope in case subclasses want to make use of it for their own purposes.<a name="line.52"></a>
<span class="sourceLineNo">053</span>     */<a name="line.53"></a>
<span class="sourceLineNo">054</span>    protected Matcher _matcher_ = null;<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span>    /**<a name="line.56"></a>
<span class="sourceLineNo">057</span>     * The constructor for a RegexFTPFileEntryParserImpl object.<a name="line.57"></a>
<span class="sourceLineNo">058</span>     *<a name="line.58"></a>
<span class="sourceLineNo">059</span>     * @param regex  The regular expression with which this object is<a name="line.59"></a>
<span class="sourceLineNo">060</span>     * initialized.<a name="line.60"></a>
<span class="sourceLineNo">061</span>     *<a name="line.61"></a>
<span class="sourceLineNo">062</span>     * @exception IllegalArgumentException<a name="line.62"></a>
<span class="sourceLineNo">063</span>     * Thrown if the regular expression is unparseable.  Should not be seen in<a name="line.63"></a>
<span class="sourceLineNo">064</span>     * normal conditions.  It it is seen, this is a sign that a subclass has<a name="line.64"></a>
<span class="sourceLineNo">065</span>     * been created with a bad regular expression.   Since the parser must be<a name="line.65"></a>
<span class="sourceLineNo">066</span>     * created before use, this means that any bad parser subclasses created<a name="line.66"></a>
<span class="sourceLineNo">067</span>     * from this will bomb very quickly,  leading to easy detection.<a name="line.67"></a>
<span class="sourceLineNo">068</span>     */<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span>    public RegexFTPFileEntryParserImpl(String regex) {<a name="line.70"></a>
<span class="sourceLineNo">071</span>        super();<a name="line.71"></a>
<span class="sourceLineNo">072</span>        setRegex(regex);<a name="line.72"></a>
<span class="sourceLineNo">073</span>    }<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span>    /**<a name="line.75"></a>
<span class="sourceLineNo">076</span>     * Convenience method delegates to the internal MatchResult's matches()<a name="line.76"></a>
<span class="sourceLineNo">077</span>     * method.<a name="line.77"></a>
<span class="sourceLineNo">078</span>     *<a name="line.78"></a>
<span class="sourceLineNo">079</span>     * @param s the String to be matched<a name="line.79"></a>
<span class="sourceLineNo">080</span>     * @return true if s matches this object's regular expression.<a name="line.80"></a>
<span class="sourceLineNo">081</span>     */<a name="line.81"></a>
<span class="sourceLineNo">082</span><a name="line.82"></a>
<span class="sourceLineNo">083</span>    public boolean matches(String s) {<a name="line.83"></a>
<span class="sourceLineNo">084</span>        this.result = null;<a name="line.84"></a>
<span class="sourceLineNo">085</span>        _matcher_ = pattern.matcher(s);<a name="line.85"></a>
<span class="sourceLineNo">086</span>        if (_matcher_.matches()) {<a name="line.86"></a>
<span class="sourceLineNo">087</span>            this.result = _matcher_.toMatchResult();<a name="line.87"></a>
<span class="sourceLineNo">088</span>        }<a name="line.88"></a>
<span class="sourceLineNo">089</span>        return null != this.result;<a name="line.89"></a>
<span class="sourceLineNo">090</span>    }<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span>    /**<a name="line.92"></a>
<span class="sourceLineNo">093</span>     * Convenience method<a name="line.93"></a>
<span class="sourceLineNo">094</span>     *<a name="line.94"></a>
<span class="sourceLineNo">095</span>     * @return the number of groups() in the internal MatchResult.<a name="line.95"></a>
<span class="sourceLineNo">096</span>     */<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span>    public int getGroupCnt() {<a name="line.98"></a>
<span class="sourceLineNo">099</span>        if (this.result == null) {<a name="line.99"></a>
<span class="sourceLineNo">100</span>            return 0;<a name="line.100"></a>
<span class="sourceLineNo">101</span>        }<a name="line.101"></a>
<span class="sourceLineNo">102</span>        return this.result.groupCount();<a name="line.102"></a>
<span class="sourceLineNo">103</span>    }<a name="line.103"></a>
<span class="sourceLineNo">104</span><a name="line.104"></a>
<span class="sourceLineNo">105</span>    /**<a name="line.105"></a>
<span class="sourceLineNo">106</span>     * Convenience method delegates to the internal MatchResult's group()<a name="line.106"></a>
<span class="sourceLineNo">107</span>     * method.<a name="line.107"></a>
<span class="sourceLineNo">108</span>     *<a name="line.108"></a>
<span class="sourceLineNo">109</span>     * @param matchnum match group number to be retrieved<a name="line.109"></a>
<span class="sourceLineNo">110</span>     *<a name="line.110"></a>
<span class="sourceLineNo">111</span>     * @return the content of the &lt;code&gt;matchnum'th&lt;/code&gt; group of the internal<a name="line.111"></a>
<span class="sourceLineNo">112</span>     *         match or null if this method is called without a match having<a name="line.112"></a>
<span class="sourceLineNo">113</span>     *         been made.<a name="line.113"></a>
<span class="sourceLineNo">114</span>     */<a name="line.114"></a>
<span class="sourceLineNo">115</span>    public String group(int matchnum) {<a name="line.115"></a>
<span class="sourceLineNo">116</span>        if (this.result == null) {<a name="line.116"></a>
<span class="sourceLineNo">117</span>            return null;<a name="line.117"></a>
<span class="sourceLineNo">118</span>        }<a name="line.118"></a>
<span class="sourceLineNo">119</span>        return this.result.group(matchnum);<a name="line.119"></a>
<span class="sourceLineNo">120</span>    }<a name="line.120"></a>
<span class="sourceLineNo">121</span><a name="line.121"></a>
<span class="sourceLineNo">122</span>    /**<a name="line.122"></a>
<span class="sourceLineNo">123</span>     * For debugging purposes - returns a string shows each match group by<a name="line.123"></a>
<span class="sourceLineNo">124</span>     * number.<a name="line.124"></a>
<span class="sourceLineNo">125</span>     *<a name="line.125"></a>
<span class="sourceLineNo">126</span>     * @return a string shows each match group by number.<a name="line.126"></a>
<span class="sourceLineNo">127</span>     */<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span>    public String getGroupsAsString() {<a name="line.129"></a>
<span class="sourceLineNo">130</span>        StringBuilder b = new StringBuilder();<a name="line.130"></a>
<span class="sourceLineNo">131</span>        for (int i = 1; i &lt;= this.result.groupCount(); i++) {<a name="line.131"></a>
<span class="sourceLineNo">132</span>            b.append(i).append(") ").append(this.result.group(i)).append(<a name="line.132"></a>
<span class="sourceLineNo">133</span>                    System.getProperty("line.separator"));<a name="line.133"></a>
<span class="sourceLineNo">134</span>        }<a name="line.134"></a>
<span class="sourceLineNo">135</span>        return b.toString();<a name="line.135"></a>
<span class="sourceLineNo">136</span>    }<a name="line.136"></a>
<span class="sourceLineNo">137</span><a name="line.137"></a>
<span class="sourceLineNo">138</span>    /**<a name="line.138"></a>
<span class="sourceLineNo">139</span>     * Alter the current regular expression being utilised for entry parsing<a name="line.139"></a>
<span class="sourceLineNo">140</span>     * and create a new {@link Pattern} instance.<a name="line.140"></a>
<span class="sourceLineNo">141</span>     * @param regex The new regular expression<a name="line.141"></a>
<span class="sourceLineNo">142</span>     * @return  true<a name="line.142"></a>
<span class="sourceLineNo">143</span>     * @since 2.0<a name="line.143"></a>
<span class="sourceLineNo">144</span>     * @throws PatternSyntaxException if the regex cannot be compiled<a name="line.144"></a>
<span class="sourceLineNo">145</span>     */<a name="line.145"></a>
<span class="sourceLineNo">146</span>    public boolean setRegex(String regex) {<a name="line.146"></a>
<span class="sourceLineNo">147</span>        try {<a name="line.147"></a>
<span class="sourceLineNo">148</span>            pattern = Pattern.compile(regex);<a name="line.148"></a>
<span class="sourceLineNo">149</span>            return true;<a name="line.149"></a>
<span class="sourceLineNo">150</span>        } catch (PatternSyntaxException pse) {<a name="line.150"></a>
<span class="sourceLineNo">151</span>            throw new IllegalArgumentException("Unparseable regex supplied: "<a name="line.151"></a>
<span class="sourceLineNo">152</span>                    + regex);<a name="line.152"></a>
<span class="sourceLineNo">153</span>        }<a name="line.153"></a>
<span class="sourceLineNo">154</span>    }<a name="line.154"></a>
<span class="sourceLineNo">155</span><a name="line.155"></a>
<span class="sourceLineNo">156</span>}<a name="line.156"></a>




























































</pre>
</div>
</body>
</html>
